ComposeInvestigator Runtime API/land.sungbin.composeinvestigator.runtime

Package-level declarations

Types

@Immutable

data class ChangedArgument(val previous: ValueArgument, val new: ValueArgument)

Indicates which arguments have changed as a result of the recomposition.

@Immutable

data class ComposableInformation(val name: String, val packageName: String, val fileName: String, val compoundKey: Int? = null)

Indicates which Composables were affected by the state change.

ComposableInvalidationLogger

fun interface ComposableInvalidationLogger

ComposableInvalidationTraceTable

@Immutable

class ComposableInvalidationTraceTable

Classes that hold data from ComposeInvestigator.

ComposableName

@Target(allowedTargets = [])

annotation class ComposableName(val name: String)

Returns the name of the current Composable. See ComposableInvalidationTraceTable.currentComposableName.

ComposableScope

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class ComposableScope

APIs annotated with this should only be used within Composable functions.

ComposeInvestigator

object ComposeInvestigator

Configures the runtime operation of ComposeInvestigator.

ComposeInvestigatorCompilerApi

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

annotation class ComposeInvestigatorCompilerApi

ExperimentalComposeInvestigatorApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class ExperimentalComposeInvestigatorApi

InvalidationResult

@Immutable

sealed class InvalidationResult

Defines the result of the invalidation requested for the Composable.

NoInvestigation

@Target(allowedTargets = [AnnotationTarget.FILE, AnnotationTarget.FUNCTION])

annotation class NoInvestigation

ComposeInvestigator does not work on annotated files or Composable functions.

Stability

@Immutable

sealed class Stability

Represents Compose's stability system. See the official documentation for more information about Compose's stability.

ValueArgument

@Immutable

data class ValueArgument(val name: String, val type: String, val valueString: String, val valueHashCode: Int, val stability: Stability)

Represents information about the Composable function's value argument.

Properties

currentComposableInvalidationTracer

@get:Stable

val currentComposableInvalidationTracer: ComposableInvalidationTraceTable

Returns the ComposableInvalidationTraceTable assigned to the current file.

fqPackageName

@get:Stable

val ComposableInformation.fqPackageName: String

Fully-qualified name of the Composable function.

Functions

getValue

operator fun ComposableName.getValue(thisRef: Any?, property: Any?): String

val name: String by ComposableName("MyComposable") // result: "MyComposable"

isExpressible

fun Stability.isExpressible(): Boolean

isUncertain

fun Stability.isUncertain(): Boolean

knownStable

fun Stability.knownStable(): Boolean

knownUnstable

fun Stability.knownUnstable(): Boolean

toCertainString

fun Stability.toCertainString(): String